feat: render READMEs in ORG format, better fallback if not MD #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Draft

mortenpi wants to merge 1 commit into master from mp/org

Member

mortenpi commented Oct 30, 2023

Uses Org.jl to render fallback docs from README.org files a bit better.
Readmes without extensions will be rendered as <pre> text.
Readmes that have an unknown extension will also get rendered as <pre>, but also have a warning box (content and styling TBD)

On the JuliaHub package page, Bumper (which has a README in org format) renders pretty well (although not perfectly):

The Documenter fallback might need a bit of work:

But it is better than the status quo:


          feat: render READMEs in ORG format

9e34500

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet